dxp-ux
Retrieve ServiceById (TMF-640)
/service/{id}
[GET]
This operation used to retrieve the status of the service.
URL
https://[localhost]:[port]/dxp-ux/v1/{businessId}/service/{id}URL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico | Y |
| id | string | customer phone number | Y |
Header
| name | type | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request | N It is mandatory for Business |
| channelId | string | Expected value 'APP' | Y |
| lob | enum | The Line of Business Identifier currently available are: FIXED PREPAID POSTPAID | N |
queryParams
| name | type | description | required |
|---|---|---|---|
| featureCharacteristic.name | String | Need to provide feature name. Example: "callforward" | Y |
| featureCharacteristic.forwardDn | String | call forwarding phone number | Y |
Response [ 200 ]
OK - list request processed successfully, response body contains an entity corresponding to the requested resource.
{
"description": "Service_Active",
"feature": [
{
"isEnabled": true,
"name": "Voice",
"featureCharacteristic": [
{
"id": "7875455880",
"name": "callforward",
"valueType": "object",
"value": [
{
"forwardDn": "7879257004"
}
]
}
]
}
],
"@type": "Feature"
}